Skip to main content

BlockEditor

The `BlockEditor` component is the main component of the editor. It is responsible for rendering the content editor.
BlockEditorProps
BlockEditorProps
augmentEditor
(baseEditor: Editor) => | void| Editor
augmentEditorBuiltins
(editor: EditorWithBlocks) => | void| EditorWithBlocks
blockButtons
| BlockHoveringToolbarConfig[]| BlockHoveringToolbarConfig[][]
children
React.ReactNode
contentField*
| string| SugaredRelativeSingleField
embedContentDiscriminationField
| string| SugaredRelativeSingleField
embedHandlers
Iterable<EmbedHandler<any>>
embedReferenceDiscriminateBy
OptionallyVariableFieldValue
expectedMutation
ExpectedRelationMutation
field*
| string| SugarableRelativeEntityList
initialEntityCount
number
inlineButtons
| ToolbarButtonSpec[]| ToolbarButtonSpec[][]
isNonbearing
boolean
label
React.ReactNode
leadingFieldBackedElements
FieldBackedElement[]
limit
number
monolithicReferencesMode
boolean
offset
number
onBeforePersist*
| undefined| EntityListAccessor.BeforePersistHandler| Set<EntityListAccessor.BeforePersistHandler>
onBeforeUpdate*
| undefined| EntityListAccessor.BatchUpdatesHandler| Set<EntityListAccessor.BatchUpdatesHandler>
onChildBeforeUpdate*
| undefined| EntityAccessor.BatchUpdatesHandler| Set<EntityAccessor.BatchUpdatesHandler>
onChildInitialize*
| undefined| EntityAccessor.BatchUpdatesHandler| Set<EntityAccessor.BatchUpdatesHandler>
onChildUpdate*
| undefined| EntityAccessor.UpdateListener| Set<EntityAccessor.UpdateListener>
onInitialize*
| undefined| EntityListAccessor.BatchUpdatesHandler| Set<EntityListAccessor.BatchUpdatesHandler>
onPersistError*
| undefined| EntityListAccessor.PersistErrorHandler| Set<EntityListAccessor.PersistErrorHandler>
onPersistSuccess*
| undefined| EntityListAccessor.PersistSuccessHandler| Set<EntityListAccessor.PersistSuccessHandler>
onUpdate*
| undefined| EntityListAccessor.UpdateListener| Set<EntityListAccessor.UpdateListener>
orderBy
SugaredOrderBy
otherBlockButtons
BlockHoveringToolbarConfig[]
placeholder
string
plugins
BuiltinEditorPlugins[]
referenceDiscriminationField
| string| SugaredRelativeSingleField
referencesField
| string| SugaredRelativeEntityList
setOnCreate
SugaredSetOnCreate
size
EditorCanvasSize
sortableBy*
| string| SugaredRelativeSingleField
toolbarScheme
Scheme
trailingFieldBackedElements
FieldBackedElement[]